* Widgets can add style classes to their context, which can be used
* to associate different styles by class (see <xref linkend="gtkcssprovider-selectors"/>). Theme engines can also use style classes to vary their
* rendering. GTK+ has a number of predefined style classes:
- * <informaltable>
- * <tgroup cols="3">
- * <thead>
- * <row>
- * <entry>Style class</entry>
- * <entry>Macro</entry>
- * <entry>Used by</entry>
- * </row>
- * </thead>
- * <tbody>
- * <row>
- * <entry>button</entry>
- * <entry>GTK_STYLE_CLASS_BUTTON</entry>
- * <entry>#GtkButton, #GtkToggleButton, #GtkRadioButton, #GtkCheckButton</entry>
- * </row>
- * <row>
- * <entry>default</entry>
- * <entry>GTK_STYLE_CLASS_DEFAULT</entry>
- * <entry>#GtkButton</entry>
- * </row>
- * <row>
- * <entry>check</entry>
- * <entry>GTK_STYLE_CLASS_CHECK</entry>
- * <entry>#GtkCheckButton, #GtkCheckMenuItem, #GtkCellRendererToggle</entry>
- * </row>
- * <row>
- * <entry>radio</entry>
- * <entry>GTK_STYLE_CLASS_RADIO</entry>
- * <entry>#GtkRadioButton, #GtkRadioMenuItem, #GtkCellRendererToggle</entry>
- * </row>
- * <row>
- * <entry>arrow</entry>
- * <entry>GTK_STYLE_CLASS_ARROW</entry>
- * <entry>#GtkArrow</entry>
- * </row>
- * <row>
- * <entry>calendar</entry>
- * <entry>GTK_STYLE_CLASS_CALENDAR</entry>
- * <entry>#GtkCalendar</entry>
- * </row>
- * <row>
- * <entry>entry</entry>
- * <entry>GTK_STYLE_CLASS_ENTRY</entry>
- * <entry>#GtkEntry</entry>
- * </row>
- * <row>
- * <entry>cell</entry>
- * <entry>GTK_STYLE_CLASS_CELL</entry>
- * <entry>#GtkCellRendererToggle</entry>
- * </row>
- * <row>
- * <entry>menu</entry>
- * <entry>GTK_STYLE_CLASS_MENU</entry>
- * <entry>#GtkMenu, #GtkMenuItem, #GtkCheckMenuItem, #GtkRadioMenuItem</entry>
- * </row>
- * <row>
- * <entry>expander</entry>
- * <entry>GTK_STYLE_CLASS_EXPANDER</entry>
- * <entry>#GtkExpander</entry>
- * </row>
- * <row>
- * <entry>tooltip</entry>
- * <entry>GTK_STYLE_CLASS_TOOLTIP</entry>
- * <entry>#GtkTooltip</entry>
- * </row>
- * <row>
- * <entry>frame</entry>
- * <entry>GTK_STYLE_CLASS_FRAME</entry>
- * <entry>#GtkFrame</entry>
- * </row>
- * <row>
- * <entry>scrolled-window</entry>
- * <entry></entry>
- * <entry>#GtkScrolledWindow</entry>
- * </row>
- * <row>
- * <entry>viewport</entry>
- * <entry></entry>
- * <entry>#GtkViewport</entry>
- * </row>
- * <row>
- * <entry>trough</entry>
- * <entry>GTK_STYLE_CLASS_TROUGH</entry>
- * <entry>#GtkScrollbar, #GtkProgressBar, #GtkScale</entry>
- * </row>
- * <row>
- * <entry>progressbar</entry>
- * <entry>GTK_STYLE_CLASS_PROGRESSBAR</entry>
- * <entry>#GtkProgressBar, #GtkCellRendererProgress</entry>
- * </row>
- * <row>
- * <entry>slider</entry>
- * <entry>GTK_STYLE_CLASS_SLIDER</entry>
- * <entry>#GtkScrollbar, #GtkScale</entry>
- * </row>
- * <row>
- * <entry>menuitem</entry>
- * <entry>GTK_STYLE_CLASS_MENUITEM</entry>
- * <entry>#GtkMenuItem</entry>
- * </row>
- * <row>
- * <entry>popup</entry>
- * <entry></entry>
- * <entry>#GtkMenu</entry>
- * </row>
- * <row>
- * <entry>accelerator</entry>
- * <entry>GTK_STYLE_CLASS_ACCELERATOR</entry>
- * <entry>#GtkAccelLabel</entry>
- * </row>
- * <row>
- * <entry>menubar</entry>
- * <entry>GTK_STYLE_CLASS_MENUBAR</entry>
- * <entry>#GtkMenuBar</entry>
- * </row>
- * <row>
- * <entry>toolbar</entry>
- * <entry>GTK_STYLE_CLASS_TOOLBAR</entry>
- * <entry>#GtkToolbar</entry>
- * </row>
- * <row>
- * <entry>dock</entry>
- * <entry>GTK_STYLE_CLASS_DOCK</entry>
- * <entry>#GtkHandleBox</entry>
- * </row>
- * <row>
- * <entry>notebook</entry>
- * <entry></entry>
- * <entry>#GtkNotebook</entry>
- * </row>
- * <row>
- * <entry>background</entry>
- * <entry>GTK_STYLE_CLASS_BACKGROUND</entry>
- * <entry>#GtkWindow</entry>
- * </row>
- * <row>
- * <entry>rubberband</entry>
- * <entry>GTK_STYLE_CLASS_RUBBERBAND</entry>
- * <entry></entry>
- * </row>
- * <row>
- * <entry>header</entry>
- * <entry>GTK_STYLE_CLASS_HEADER</entry>
- * <entry></entry>
- * </row>
- * <row>
- * <entry>grip</entry>
- * <entry>GTK_STYLE_CLASS_GRIP</entry>
- * <entry>#GtkWindow</entry>
- * </row>
- * <row>
- * <entry>spinner</entry>
- * <entry>GTK_STYLE_CLASS_SPINNER</entry>
- * <entry>#GtkSpinner</entry>
- * </row>
- * </tbody>
- * </tgroup>
- * </informaltable>
+ * #GTK_STYLE_CLASS_CELL,
+ * #GTK_STYLE_CLASS_ENTRY,
+ * #GTK_STYLE_CLASS_BUTTON,
+ * #GTK_STYLE_CLASS_CALENDAR,
+ * #GTK_STYLE_CLASS_SLIDER,
+ * #GTK_STYLE_CLASS_BACKGROUND,
+ * #GTK_STYLE_CLASS_RUBBERBAND,
+ * #GTK_STYLE_CLASS_TOOLTIP,
+ * #GTK_STYLE_CLASS_MENU,
+ * #GTK_STYLE_CLASS_MENUBAR,
+ * #GTK_STYLE_CLASS_MENUITEM,
+ * #GTK_STYLE_CLASS_TOOLBAR,
+ * #GTK_STYLE_CLASS_PRIMARY_TOOLBAR,
+ * #GTK_STYLE_CLASS_INLINE_TOOLBAR,
+ * #GTK_STYLE_CLASS_RADIO,
+ * #GTK_STYLE_CLASS_CHECK,
+ * #GTK_STYLE_CLASS_TROUGH,
+ * #GTK_STYLE_CLASS_SCROLLBAR,
+ * #GTK_STYLE_CLASS_SCALE,
+ * #GTK_STYLE_CLASS_SCALE_HAS_MARKS_ABOVE,
+ * #GTK_STYLE_CLASS_SCALE_HAS_MARKS_BELOW,
+ * #GTK_STYLE_CLASS_HEADER,
+ * #GTK_STYLE_CLASS_ACCELERATOR,
+ * #GTK_STYLE_CLASS_GRIP,
+ * #GTK_STYLE_CLASS_DOCK,
+ * #GTK_STYLE_CLASS_PROGRESSBAR,
+ * #GTK_STYLE_CLASS_SPINNER,
+ * #GTK_STYLE_CLASS_EXPANDER,
+ * #GTK_STYLE_CLASS_SPINBUTTON,
+ * #GTK_STYLE_CLASS_NOTEBOOK,
+ * #GTK_STYLE_CLASS_VIEW,
+ * #GTK_STYLE_CLASS_SIDEBAR,
+ * #GTK_STYLE_CLASS_IMAGE,
+ * #GTK_STYLE_CLASS_HIGHLIGHT,
+ * #GTK_STYLE_CLASS_FRAME,
+ * #GTK_STYLE_CLASS_DND,
+ * #GTK_STYLE_CLASS_PANE_SEPARATOR,
+ * #GTK_STYLE_CLASS_SEPARATOR,
+ * #GTK_STYLE_CLASS_INFO,
+ * #GTK_STYLE_CLASS_WARNING,
+ * #GTK_STYLE_CLASS_QUESTION,
+ * #GTK_STYLE_CLASS_ERROR,
+ * #GTK_STYLE_CLASS_HORIZONTAL,
+ * #GTK_STYLE_CLASS_VERTICAL.
* </para>
* <para>
* Widgets can also add regions with flags to their context.
* GTK_STYLE_CLASS_CELL:
*
* A CSS class to match content rendered in cell views.
+ *
+ * This is used by cell renderers, e.g. in #GtkIconView
+ * and #GtkTreeView.
*/
#define GTK_STYLE_CLASS_CELL "cell"
* GTK_STYLE_CLASS_ENTRY:
*
* A CSS class to match text entries.
+ *
+ * This is used by #GtkEntry.
*/
#define GTK_STYLE_CLASS_ENTRY "entry"
* GTK_STYLE_CLASS_BUTTON:
*
* A CSS class to match buttons.
+ *
+ * This is used by #GtkButton and its subclasses, as well
+ * as various other widget pieces that appear like buttons,
+ * e.g. the arrows in a #GtkCalendar.
*/
#define GTK_STYLE_CLASS_BUTTON "button"
* GTK_STYLE_CLASS_CALENDAR:
*
* A CSS class to match calendars.
+ *
+ * This is not used by GTK+ itself, currently.
*/
#define GTK_STYLE_CLASS_CALENDAR "calendar"
* GTK_STYLE_CLASS_SLIDER:
*
* A CSS class to match sliders.
+ *
+ * This is used by #GtkSwitch and #GtkRange and its subclasses.
*/
#define GTK_STYLE_CLASS_SLIDER "slider"
* GTK_STYLE_CLASS_RUBBERBAND:
*
* A CSS class to match the rubberband selection rectangle.
+ *
+ * This is used in #GtkIconView and #GtkTreeView.
*/
#define GTK_STYLE_CLASS_RUBBERBAND "rubberband"
* GTK_STYLE_CLASS_MENU:
*
* A CSS class to match popup menus.
+ *
+ * This is used in #GtkMenu.
*/
#define GTK_STYLE_CLASS_MENU "menu"
* GTK_STYLE_CLASS_MENUBAR:
*
* A CSS class to menubars.
+ *
+ * This is used in #GtkMenuBar.
*/
#define GTK_STYLE_CLASS_MENUBAR "menubar"
* GTK_STYLE_CLASS_MENUITEM:
*
* A CSS class to match menu items.
+ *
+ * This is used in #GtkMenuItem and its subclasses.
*/
#define GTK_STYLE_CLASS_MENUITEM "menuitem"
* GTK_STYLE_CLASS_TOOLBAR:
*
* A CSS class to match toolbars.
+ *
+ * This is used in #GtkToolbar.
*/
#define GTK_STYLE_CLASS_TOOLBAR "toolbar"
* GTK_STYLE_CLASS_PRIMARY_TOOLBAR:
*
* A CSS class to match primary toolbars.
+ *
+ * This should be used for the 'main' toolbar of an application,
+ * right below its menubar.
*/
#define GTK_STYLE_CLASS_PRIMARY_TOOLBAR "primary-toolbar"
* GTK_STYLE_CLASS_INLINE_TOOLBAR:
*
* A CSS class to match inline toolbars.
+ *
+ * This should be used for toolbars that are used to hold
+ * actions below lists, as seen e.g. in the left pane of the
+ * file chooser.
*/
#define GTK_STYLE_CLASS_INLINE_TOOLBAR "inline-toolbar"
* GTK_STYLE_CLASS_RADIO:
*
* A CSS class to match radio buttons.
+ *
+ * This is used in #GtkRadioButton, #GtkRadioMenuItem and
+ * #GtkCellRendererToggle.
*/
#define GTK_STYLE_CLASS_RADIO "radio"
* GTK_STYLE_CLASS_CHECK:
*
* A CSS class to match check boxes.
+ *
+ * This is used in #GtkCheckButton, #GtkCheckMenuItem and
+ * #GtkCellRendererToggle.
*/
#define GTK_STYLE_CLASS_CHECK "check"
* GTK_STYLE_CLASS_DEFAULT:
*
* A CSS class to match the default widget.
+ *
+ * This is used by #GtkButton.
*/
#define GTK_STYLE_CLASS_DEFAULT "default"
* GTK_STYLE_CLASS_TROUGH:
*
* A CSS class to match troughs, as in scrollbars and progressbars.
+ *
+ * This is used in #GtkRange and its subclasses, #GtkProgressBar
+ * and #GtkSwitch.
*/
#define GTK_STYLE_CLASS_TROUGH "trough"
* GTK_STYLE_CLASS_SCALE:
*
* A CSS class to match scale widgets.
+ *
+ * This is used in #GtkScale.
*/
#define GTK_STYLE_CLASS_SCALE "scale"
* GTK_STYLE_CLASS_HEADER:
*
* A CSS class to match a header element.
+ *
+ * This is used for the header in #GtkCalendar.
*/
#define GTK_STYLE_CLASS_HEADER "header"
* GTK_STYLE_CLASS_ACCELERATOR:
*
* A CSS class to match an accelerator.
+ *
+ * This is used for the accelerator in #GtkAccelLabel.
*/
#define GTK_STYLE_CLASS_ACCELERATOR "accelerator"
*
* A CSS class to match a raised control, such as a raised
* button on a toolbar.
+ *
+ * This should be used in conjunction with #GTK_STYLE_CLASS_PRIMARY_TOOLBAR.
*/
#define GTK_STYLE_CLASS_RAISED "raised"
/**
* GTK_STYLE_CLASS_GRIP:
*
- * A widget class defining a resize grip
+ * A CSS class defining a resize grip.
+ *
+ * This is used for the resize grip in #GtkWindow.
*/
#define GTK_STYLE_CLASS_GRIP "grip"
/**
* GTK_STYLE_CLASS_DOCK:
*
- * A widget class defining a dock area
+ * A CSS class defining a dock area.
+ *
+ * This is used by #GtkHandleBox.
*/
#define GTK_STYLE_CLASS_DOCK "dock"
/**
* GTK_STYLE_CLASS_PROGRESSBAR:
*
- * A widget class defining a resize grip
+ * A CSS class to use when rendering activity as a progressbar.
+ *
+ * This is used in #GtkProgressBar and when drawing progress
+ * inside a #GtkEntry or in #GtkCellRendererProgress.
*/
#define GTK_STYLE_CLASS_PROGRESSBAR "progressbar"
/**
* GTK_STYLE_CLASS_SPINNER:
*
- * A widget class defining a spinner
+ * A CSS class to use when rendering activity as a 'spinner'.
+ *
+ * This is used by #GtkSpinner and #GtkCellRendererSpinner.
*/
#define GTK_STYLE_CLASS_SPINNER "spinner"
/**
* GTK_STYLE_CLASS_MARK:
*
- * A widget class defining marks in a widget, such as in scales
+ * A CSS class defining marks in a widget, such as in scales.
+ *
+ * Used in #GtkScale.
*/
#define GTK_STYLE_CLASS_MARK "mark"
/**
* GTK_STYLE_CLASS_EXPANDER:
*
- * A widget class defining an expander, such as those in treeviews
+ * A CSS class defining an expander, such as those in treeviews.
+ *
+ * Used for drawing expanders in #GtkTreeView, GtkExpander and
+ * #GtkToolItemGroup.
*/
#define GTK_STYLE_CLASS_EXPANDER "expander"
/**
* GTK_STYLE_CLASS_SPINBUTTON:
*
- * A widget class defining an spinbutton
+ * A CSS class defining an spinbutton.
+ *
+ * This is used in #GtkSpinButton.
*/
#define GTK_STYLE_CLASS_SPINBUTTON "spinbutton"
/**
* GTK_STYLE_CLASS_NOTEBOOK:
*
- * A widget class defining a notebook
+ * A CSS class defining a notebook.
+ *
+ * Used in #GtkNotebook.
*/
#define GTK_STYLE_CLASS_NOTEBOOK "notebook"
/**
* GTK_STYLE_CLASS_VIEW:
*
- * A widget class defining a view, such as iconviews or treeviews
+ * A CSS class defining a view, such as iconviews or treeviews.
+ *
+ * This is used in #GtkTreeView, #GtkIconView, #GtkTextView,
+ * as well as #GtkCalendar.
*/
#define GTK_STYLE_CLASS_VIEW "view"
/**
* GTK_STYLE_CLASS_SIDEBAR:
*
- * A widget class defining a sidebar
+ * A CSS class defining a sidebar, such as the left side in
+ * a file chooser.
+ *
+ * This is used in #GtkFileChooser and in #GtkAssistant.
*/
#define GTK_STYLE_CLASS_SIDEBAR "sidebar"
/**
* GTK_STYLE_CLASS_IMAGE:
*
- * A widget class defining an image, such as the icon in an entry.
+ * A CSS class defining an image, such as the icon in an entry.
+ *
+ * This is used when rendering icons in #GtkEntry.
*/
#define GTK_STYLE_CLASS_IMAGE "image"
* GTK_STYLE_CLASS_HIGHLIGHT:
*
* A CSS class defining a highlighted area, such as headings in
- * assistants.
+ * assistants and calendars.
+ *
+ * This is used in #GtkAssistant and #GtkCalendar.
*/
#define GTK_STYLE_CLASS_HIGHLIGHT "highlight"
/**
* GTK_STYLE_CLASS_FRAME:
*
- * A CSS class defining a frame delimiting content, such as GtkFrame
- * or the scrolled window frame around the scrollable area.
+ * A CSS class defining a frame delimiting content, such as
+ * #GtkFrame or the scrolled window frame around the
+ * scrollable area.
+ *
+ * This is used in #GtkFrame and #GtkScrollbar.
*/
#define GTK_STYLE_CLASS_FRAME "frame"
/**
* GTK_STYLE_CLASS_DND:
*
- * A CSS class for a drag-and-drop indicator
+ * A CSS class for a drag-and-drop indicator.
+ *
+ * This is used when drawing an outline around a potential
+ * drop target during DND.
*/
#define GTK_STYLE_CLASS_DND "dnd"
* GTK_STYLE_CLASS_PANE_SEPARATOR:
*
* A CSS class for a pane separator, such as those in #GtkPaned.
+ *
+ * Used in #GtkPaned.
*/
#define GTK_STYLE_CLASS_PANE_SEPARATOR "pane-separator"
* GTK_STYLE_CLASS_SEPARATOR:
*
* A CSS class for a separator.
+ *
+ * This is used in #GtkSeparator, #GtkSeparatorMenuItem,
+ * #GtkSeparatorToolItem, and when drawing separators in #GtkTreeView.
*/
#define GTK_STYLE_CLASS_SEPARATOR "separator"
/**
* GTK_STYLE_CLASS_INFO:
*
- * A widget class for an area displaying an informational message,
- * such as those in infobars
+ * A CSS class for an area displaying an informational message,
+ * such as those in infobars.
+ *
+ * This is used by #GtkInfoBar.
*/
#define GTK_STYLE_CLASS_INFO "info"
/**
* GTK_STYLE_CLASS_WARNING:
*
- * A widget class for an area displaying a warning message,
- * such as those in infobars
+ * A CSS class for an area displaying a warning message,
+ * such as those in infobars.
+ *
+ * This is used by #GtkInfoBar.
*/
#define GTK_STYLE_CLASS_WARNING "warning"
/**
* GTK_STYLE_CLASS_QUESTION:
*
- * A widget class for an area displaying a question to the user,
- * such as those in infobars
+ * A CSS class for an area displaying a question to the user,
+ * such as those in infobars.
+ *
+ * This is used by #GtkInfoBar.
*/
#define GTK_STYLE_CLASS_QUESTION "question"
/**
* GTK_STYLE_CLASS_ERROR:
*
- * A widget class for an area displaying an error message,
- * such as those in infobars
+ * A CSS class for an area displaying an error message,
+ * such as those in infobars.
+ *
+ * This is used by #GtkInfoBar.
*/
#define GTK_STYLE_CLASS_ERROR "error"
/**
* GTK_STYLE_CLASS_HORIZONTAL:
*
- * A widget class for horizontally layered widgets.
+ * A CSS class for horizontally layered widgets.
+ *
+ * This is used by widgets implementing #GtkOrientable.
*/
#define GTK_STYLE_CLASS_HORIZONTAL "horizontal"
/**
* GTK_STYLE_CLASS_VERTICAL:
*
- * A widget class for vertically layered widgets.
+ * A CSS class for vertically layered widgets.
+ *
+ * This is used by widgets implementing #GtkOrientable.
*/
#define GTK_STYLE_CLASS_VERTICAL "vertical"
projects / gtk4.git / commitdiff